Sdk user story #5952

bmarty · 2022-05-05T17:01:00Z

This PR add some cleanup on the SDK documentation and on the API. See commit messages for the details.

Also it introduced the SDK user Story, with their documentation:

and for Us100SignIn for instance:

This is still WIP, but we can merge as it is and update later, to first check that the format is OK.

github-actions · 2022-05-05T17:18:43Z

Unit Test Results

124 files ±  0 124 suites ±0 2m 1s ⏱️ -1s
220 tests +  3 220 ✔️ +  3 0 💤 ±0 0 ❌ ±0
726 runs +12 726 ✔️ +12 0 💤 ±0 0 ❌ ±0

Results for commit 8f06415. ± Comparison against base commit 109b381.

This pull request removes 1 and adds 4 tests. Note that renamed tests count towards both.

im.vector.app.features.onboarding.ftueauth.FtueMissingRegistrationStagesComparatorTest ‑ when ordering stages, then prioritizes email

im.vector.app.features.onboarding.RegistrationActionHandlerTest ‑ given adding an email ThreePid fails with 401, when handling register action, then infer EmailSuccess
im.vector.app.features.onboarding.RegistrationActionHandlerTest ‑ given email verification errors with 401 and succeeds, when checking email validation, then continues to poll until success
im.vector.app.features.onboarding.RegistrationActionHandlerTest ‑ given email verification errors with 401 then fatal error, when checking email validation, then continues to poll until non 401 error
im.vector.app.features.onboarding.ftueauth.MatrixOrgRegistrationStagesComparatorTest ‑ when ordering stages, then prioritizes email

♻️ This comment has been updated with latest results.

mnaturel · 2022-05-12T07:31:58Z

...roid/src/main/java/org/matrix/android/sdk/api/session/crypto/keysbackup/KeysBackupService.kt

+        get() = keysBackupVersion?.version
+
+    fun isEnabled(): Boolean
+    fun isStucked(): Boolean


I guess it should be isStuck() instead. The version with "ed" seems to not exist.

When renaming a method which is exposed as an API, should we add an entry in the changelog?

Ah yes, will add.

mnaturel · 2022-05-12T07:43:12Z

matrix-sdk-android/docs/packages.md

@@ -1,3 +1,7 @@
+# Package org.matrix.android.sdk._userstories


The "_" should be removed since you renamed it without it.

Good catch, thanks. Sadly Dokka does not complain :/

With the fix, we can see that the package description is back (to compare with the screenshot in this PR description):

mnaturel · 2022-05-12T07:49:00Z

matrix-sdk-android/src/main/java/org/matrix/android/sdk/userstories/Us000InitMatrix.kt

+ * ### Required APIs:
+ * - [org.matrix.android.sdk.api.Matrix] constructor
+ */
+object Us000InitMatrix


I have 2 questions:

do the user stories really need to be object? I think simple class could work and avoid loading of non used US at runtime.

Am I missing something or the US are not implemented yet? If not implemented, would't be better to make it internal or at least mention it in the doc?

Good point. Yes this could be class, that's better. Also maybe with a private constructor. Those classes are just here to be visible in the documentation.
This is not ideal, if you have a better idea...

mnaturel

I have just added a comment about whether we should add changelog entry for the renaming of the isStuck method.

Dokka will generate a better documentation (`Functions` and `Properties` are 2 distinct tab), and for Service it's better to have only `fun`

… and `state` has been renamed to `getState` and is now a fun.

Dokka does not complain about unknown package in this file :/

yostyle · 2022-05-24T07:37:15Z

...sdk-android/src/main/java/org/matrix/android/sdk/api/auth/registration/RegistrationResult.kt

+/**
+ * Either a session or an object containing data about registration stages.
+ */


When you have a basic documentation, you could replace by a single line comment. This avoids overloading the file with comment lines

Suggested change

/**

* Either a session or an object containing data about registration stages.

*/

/** Either a session or an object containing data about registration stages. */

This is definitely more compact. I will think about it for next changes.
With the current format, it's easier to add new lines.

github-actions · 2022-05-30T17:30:01Z

Matrix SDK

Integration Tests Results:

[org.matrix.android.sdk.session]
= passed=20 failures=0 errors=0 skipped=3
[org.matrix.android.sdk.account]
= passed=3 failures=0 errors=0 skipped=2
[org.matrix.android.sdk.internal]
= passed=23 failures=1 errors=0 skipped=1
[org.matrix.android.sdk.ordering]
= passed=16 failures=0 errors=0 skipped=0
[org.matrix.android.sdk.PermalinkParserTest]
= passed=2 failures=0 errors=0 skipped=0

bmarty force-pushed the feature/bma/sdk_user_story branch from 322937a to d09acce Compare May 11, 2022 13:06

bmarty marked this pull request as ready for review May 11, 2022 13:17

bmarty requested review from a team, yostyle and mnaturel and removed request for a team May 11, 2022 13:17

mnaturel reviewed May 12, 2022

View reviewed changes

bmarty requested a review from mnaturel May 12, 2022 12:59

mnaturel reviewed May 16, 2022

View reviewed changes

bmarty force-pushed the feature/bma/sdk_user_story branch from 901d339 to eb57680 Compare May 18, 2022 14:25

bmarty added 19 commits May 20, 2022 21:14

Use Kdoc format, else it's not extracted to the documentation by dokka

bad62be

Create _userstories package and add the 2 first user stories

96c825e

Add other user stories (with TODO)

cfd6456

Change val to fun on the SDK interfaces.

e6c8ffd

Dokka will generate a better documentation (`Functions` and `Properties` are 2 distinct tab), and for Service it's better to have only `fun`

Rename currentThreePid to getCurrentThreePid

768df33

Extract HttpPusher to its own file

d3d17eb

Extract KeyRef to its own file

1ab4ae9

Change in KeysBackupService: isEnabled and isStucked are now fun,…

ede7846

… and `state` has been renamed to `getState` and is now a fun.

Method onSecretKeyGossip doe snot have to be in the public interface

853c0a2

Please ktlint. Ok, the user story will appear at the end of the doc.

740acda

Fix test compilation

6e3979a

Improve documentation

d92875e

Improve documentation

dc1eba2

Changelog

268c41a

Fix post rebase issue

8d74acf

Typo: isStucked -> isStuck

8218d8f

Package have been renamed, so also rename it here.

827c7e5

Dokka does not complain about unknown package in this file :/

class with private constructor instead of object

b866935

Add note about API renaming

0307e57

bmarty and others added 2 commits May 20, 2022 21:14

Fix compilation issue

92d54dc

Add missing punctuation

53c83ab

bmarty force-pushed the feature/bma/sdk_user_story branch from eb57680 to 53c83ab Compare May 20, 2022 19:23

yostyle reviewed May 24, 2022

View reviewed changes

Fix compilation issue after rebase

8f06415

mnaturel approved these changes May 25, 2022

View reviewed changes

bmarty merged commit ae94f45 into develop May 30, 2022

bmarty deleted the feature/bma/sdk_user_story branch May 30, 2022 16:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sdk user story #5952

Sdk user story #5952

bmarty commented May 5, 2022 •

edited

Loading

github-actions bot commented May 5, 2022 •

edited

Loading

mnaturel May 12, 2022

mnaturel May 16, 2022

bmarty May 18, 2022

bmarty May 18, 2022

mnaturel May 12, 2022

bmarty May 12, 2022

bmarty May 12, 2022

mnaturel May 12, 2022

bmarty May 12, 2022

mnaturel left a comment

yostyle May 24, 2022

bmarty May 25, 2022

github-actions bot commented May 30, 2022

		@@ -1,3 +1,7 @@
		# Package org.matrix.android.sdk._userstories

Sdk user story #5952

Sdk user story #5952

Conversation

bmarty commented May 5, 2022 • edited Loading

github-actions bot commented May 5, 2022 • edited Loading

Unit Test Results

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mnaturel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 30, 2022

Matrix SDK

Integration Tests Results:

bmarty commented May 5, 2022 •

edited

Loading

github-actions bot commented May 5, 2022 •

edited

Loading